Salesforce UX API

(0 reviews)

TMF-640 Service - Update and Retrieve Network Settings

1. Enable or Disable Network Settings

International Roaming (Voice, SMS and Data)
Data Service
Call Barring service

URL

https://[localhost]:[port]/sfdc-ux/v1/{businessId}/service/{id}

url Param

name	type	description	required
businessId	string	2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit.	Y
id	string	unique identifier of a service. Subscriber id in this case	Y

name	type	description	required
client_id	string	The client_id identifying the channel.	Y
client_secret	string	Password associated with the client_id.	Y
X-Correlation-ID	string	Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. Note - Mule default behavior creates a sample x-correlation-id field if value is not passed from client, API will use this value in case value is not passed in API request	Y

cURL request

curl --location --request PATCH 'https://nonprod.esb.cloud.lla.com/dev/sfdc-ux/v1/PR/service/S-2334-7654' \
--header 'X-Correlation-ID: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b' \
--header 'client_id: abcde' \
--header 'client_secret: 123456' \
--header 'Content-Type: application/json' \
--data '{
    "feature": [
        {
            "name": "Roaming",
            "featureCharacteristic": [
                {
                    "name": "LLARoamingService",
                    "value": "On"    //On or Off
                },
                {
                    "name": "LLARoamingDataService",
                    "value": "On"    //On or Off
                },
                {
                    "name": "LLAInternationalService",
                    "value": "On"    //On or Off
                }
            ]
        },
            {
                "name": "DataService",
                "featureCharacteristic": [
                    {
                        "name": "LLADataService",
                        "value": "On"   //On or Off
                    }
                ]
            },
            {
                "name": "CallBarringService",
                "featureCharacteristic": [
                    {
                        "name": "LLAVoiceService",
                        "value": "Off"    //On or Off
                    }
                ]
            }
    ],
    "serviceCharacteristic": [
        {
            "name": "LLAApiEventdata",
            "valueType": "object",
            "value": {
                "Channel": "SFDC-B2B",
                "ReasonCode": "Customer Request",
                "TransactionId": "12-06-2056-677"
            }
        }
    ]
}'

Definitions

Each of the request parameters is detailed.

name	type	description	required
feature	array	A list of feature associated with this service	Y
feature.name	string	This is the name for the feature	Y
feature.featureCharacteristic	array	This is a list of Characteristics for a particular feature	Y
serviceCharacteristic	array	A list of characteristics that characterize this service	Y

charactereristics:

characteristic name	type	description
featureCharacteristic.name	string	Name of the characteristic which needs to be ON/OFF
featureCharacteristic.value	string	Value to ON/OFF the characterestic
serviceCharacteristic.name	string	Name of the Service characteristic
serviceCharacteristic.valueType	string	Data type of the value of the characteristic
serviceCharacteristic.value	object	Value of the characteristic
serviceCharacteristic.value.channel	string	Name of the Channel. Ex : SFDC-B2B
serviceCharacteristic.value.reasonCode	string	Reason for this transaction
serviceCharacteristic.value.transactionId	string	Unique transaction id to identify the transaction

Response

{
    "id": "3534637",
    "feature": [
        {
            "name": "Roaming",
            "featureCharacteristic": [
                {
                    "name": "LLARoamingService",
                    "value": "On"
                },
                {
                    "name": "LLARoamingDataService",
                    "value": "On"
                },
                {
                    "name": "LLAInternationalService",
                    "value": "On"
                }
            ]
        },
        {
            "name": "DataService",
            "featureCharacteristic": [
                {
                    "name": "LLADataService",
                    "value": "On"
                }
            ]
        },
        {
            "name": "CallBarringService",
            "featureCharacteristic": [
                {
                    "name": "LLAVoiceService",
                    "value": "Off"
                }
            ]
        }
    ],
    "serviceCharacteristic": [
        {
            "name": "LLAApiEventdata",
            "valueType": "object",
            "value": {
                "Channel": "SFDC-B2B",
                "ReasonCode": "Customer Request",
                "TransactionId": "12-06-2023"
            }
        }
    ]
}

Definitions

Each of the response parameters is detailed.

name	type	description	required
id	string	Subscriber id	Y
feature	array	A list of feature associated with this service	Y
feature.name	string	This is the name for the feature	Y
feature.featureCharacteristic	array	This is a list of Characteristics for a particular feature	Y
serviceCharacteristic	array	A list of characteristics that characterize this service	Y

charactereristics:

characteristic name	type	description
featureCharacteristic.name	string	Name of the characteristic which needs to be ON/OFF
featureCharacteristic.value	string	Value to ON/OFF the characterestic
serviceCharacteristic.name	string	Name of the Service characteristic
serviceCharacteristic.valueType	string	Data type of the value of the characteristic
serviceCharacteristic.value	object	Value of the characteristic
serviceCharacteristic.value.channel	string	Name of the Channel. Ex : SFDC-B2B
serviceCharacteristic.value.reasonCode	string	Reason for this transaction
serviceCharacteristic.value.transactionId	string	Unique transaction id to identify the transaction

Possible response error

In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.

[ 400 ]

Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

{
  "errors" : [{
      "code" : 400,
      "message" : "The request is invalid or not properly formed.",
      "description" : "Malformed request syntax, invalid request message framing, or deceptive request routing."
    }]
}

[ 401 ]

Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource.

{
  "errors" : [{
      "code" : 401,
      "message" : "The user could not be authenticated for this request.",
      "description" : "The request has not been applied because it lacks valid authentication credentials for the target resource"
    }]
}

[ 404 ]

Not Found - server has not found a resource with that URI. This may be temporary and permanent condition. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.

{
  "errors" : [{
      "code" : 404,
      "message" : "The request is invalid or not properly formed.",
      "description" : "The requested operation failed because a resource associated with the request could not be found."
    }]
}

[ 405 ]

Method Not Allowed - HTTP method not allowed for this resource. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

{
    "errors": [{
            "code": 405,
             "message": "APIKIT:METHOD_NOT_ALLOWED",
             "description": "HTTP Method DELETE not allowed for : /{businessId}/service/{id}"
        }]
}

[ 500 ]

Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.

{
  "errors" : [{
      "code" : 500,
      "message" : "Internal Server Error",
      "description": "The request failed due to an internal error"
    }]
}

[ 501 ]

Not implemented - indicates that the server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.

{
  "errors" : [{
      "code" : 501,
      "message" : "Not implemented",
      "description" : "Operation PATCH /service/{id} for Business Id: xxxx not implemented"
    }]
  }

============================================================================================================================================================================

2. Retrieve Network Settings status.

International Roaming (Voice, SMS and Data)
Data Service
Call Barring service

URL

https://[localhost]:[port]/sfdc-ux/v1/{businessId}/service

url Param

name	type	description	required
businessId	string	2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit.	Y

Query Param

name	type	description	required
relatedEntity.id	string	Subscriber id	Y

name	type	description	required
client_id	string	The client_id identifying the channel.	Y
client_secret	string	Password associated with the client_id.	Y
X-Correlation-ID	string	Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. Note - Mule default behavior creates a sample x-correlation-id field if value is not passed from client, API will use this value in case value is not passed in API request	Y

cURL request

curl --location --globoff 'https://nonprod.esb.cloud.lla.com/dev/matrixx-product-ordering-sys/v1/PR/service?relatedEntity.id=47575869' \
--header 'X-Correlation-ID: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b' \
--header 'client_id: abcde' \
--header 'client_secret: 123456'

Response

[
    {
        "feature": [
            {
                "name": "Roaming",
                "featureCharacteristic": [
                    {
                        "name": "LLARoamingService",
                        "value": "Off"
                    },
                    {
                        "name": "LLARoamingDataService",
                        "value": "On"
                    },
                    {
                        "name": "LLAInternationalService",
                        "value": "Off"
                    }
                ]
            },
            {
                "name": "DataService",
                "featureCharacteristic": [
                    {
                        "name": "LLADataService",
                        "value": "On"
                    }
                ]
            },
            {
                "name": "CallBarringService",
                "featureCharacteristic": [
                    {
                        "name": "LLAVoiceService",
                        "value": "On"
                    }
                ]
            }
        ],
        "relatedEntity": [
            {
                "id": "S-3445733",
                "name": "SubscriptionExternalId",
                "role": "subscriber"
            }
        ]
    }
]

Definitions

Each of the response parameters is detailed.

name	type	description	required
feature	array	A list of feature associated with this service	Y
feature.name	string	This is the name for the feature	Y
feature.featureCharacteristic	array	This is a list of Characteristics for a particular feature	Y
relatedEntity	array	A list of related entity in relationship with this service	Y
relatedEntity.id	string	Subscriber Id	Y
relatedEntity.name	string	Name of the related entity	Y
relatedEntity.role	string	Role of the frelated entity	Y

charactereristics:

characteristic name	type	description
featureCharacteristic.name	string	Name of the characteristic which needs to be ON/OFF
featureCharacteristic.value	string	Value to ON/OFF the characterestic

Possible response error

In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.

[ 400 ]

Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

{
  "errors" : [{
      "code" : 400,
      "message" : "The request is invalid or not properly formed.",
      "description" : "Malformed request syntax, invalid request message framing, or deceptive request routing."
    }]
}

[ 401 ]

Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource.

{
  "errors" : [{
      "code" : 401,
      "message" : "The user could not be authenticated for this request.",
      "description" : "The request has not been applied because it lacks valid authentication credentials for the target resource"
    }]
}

[ 404 ]

{
  "errors" : [{
      "code" : 404,
      "message" : "The request is invalid or not properly formed.",
      "description" : "The requested operation failed because a resource associated with the request could not be found."
    }]
}

[ 405 ]

Method Not Allowed - HTTP method not allowed for this resource. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

{
    "errors": [{
            "code": 405,
             "message": "APIKIT:METHOD_NOT_ALLOWED",
             "description": "HTTP Method DELETE not allowed for : /{businessId}/service"
        }]
}

[ 500 ]

Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.

{
  "errors" : [{
      "code" : 500,
      "message" : "Internal Server Error",
      "description": "The request failed due to an internal error"
    }]
}

[ 501 ]

{
  "errors" : [{
      "code" : 501,
      "message" : "Not implemented",
      "description" : "Operation GET /service for Business Id: xxxx not implemented"
    }]
  }

Reviews

Salesforce UX API

TMF-640 Service - Update and Retrieve Network Settings

1. Enable or Disable Network Settings

URL

url Param

Header

cURL request

Definitions

Response

Definitions

Possible response error

[ 400 ]

[ 401 ]

[ 404 ]

[ 405 ]

[ 500 ]

[ 501 ]

2. Retrieve Network Settings status.

URL

url Param

Query Param

Header

cURL request

Response

Definitions

Possible response error

[ 400 ]

[ 401 ]

[ 404 ]

[ 405 ]

[ 500 ]

[ 501 ]

Reviews